home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / dev / misc / fcxref.lha / FCXRef / ReadMe.txt < prev   
Text File  |  1999-02-08  |  3KB  |  76 lines
  1.  
  2.                                  CXRef.doc
  3.  
  4.     Free   software.   But  if  you  use  it,  please  send  an  e-mail.
  5. Redistribute  is  allowed,  but only with the full source. Read the licence.
  6. The  GNU  General  Public  Licence  is  valid for all files in this archive.
  7. ----------------------------------------------------------------------------
  8.  
  9.     This  is  a  utility for programmers, for give help for a keystroke,
  10. like  the  'Function  reference'  function of GoldED. If your editor support
  11. Rexx,  then  you can easily connect it with CXRef. The program is commodity,
  12. just for unburden the removing.
  13. ----------------------------------------------------------------------------
  14.  
  15. 1)  You have to create the reference file, before use the main program. This
  16. is simple:
  17.  
  18.     mref -q c.xref Autodoc: ADE:include ADE:os-include
  19.  
  20. This line make the xref file for gcc. Format of mref:
  21.  
  22.     mref [options] databasefilename dir1 [dir2 ... dirN]
  23.  
  24. Options:
  25.     -q    Quiet mode (do not echo any warnings)
  26.     -g    GoldED mode (default: CED mode)
  27.         There some difference with the line numbering of some
  28.         editors. For example the GoldED count the non-printable
  29.         chars like a full line, but the CED includes some
  30.         non-printable character in the next line.
  31.     -u    Unique keys only
  32.         When use this option, the duplicated keys will deleted both,
  33.         without this option, one of the duplicated keys remain in
  34.         the database.
  35.     -s    Add structures into the database
  36.  
  37.     The option abbreviation (-qgu) is not implemented.
  38. ----------------------------------------------------------------------------
  39.  
  40. 2)  You have to write a simple ARexx script for the editor. (I wrote one for
  41. CED)
  42.  
  43. ARexx commands for CXRef:
  44.  
  45.     QUIT    Quiting
  46.     SEARCH    WORD function
  47.         Find the function (case sensitive) in the database, and give
  48.         you the full filename and line number in the result. For
  49.         example:
  50.         SEARCH WORD OpenLibrary
  51.         result=="Autodoc:exec.doc 3428"
  52.     SEARCH    STEM res. WORD function
  53.         This is the same, but you get the result into the supplied
  54.         variable instead in result.
  55.         SEARCH STEM ret. WORD OpenLibrary
  56.         ret.filename=="Autodoc:exec.doc"
  57.         ret.linenumber=="3428"
  58. ----------------------------------------------------------------------------
  59.  
  60. 3)  Set  the  tooltype  'XREFFILE'  according  to the place and name of your
  61. database file. (XREFFILE=DH0:Programming/full.xref)
  62. ----------------------------------------------------------------------------
  63.  
  64. 4) Install the script into your editor.
  65. ----------------------------------------------------------------------------
  66.  
  67. Used programs:
  68.  
  69.     gcc
  70.     libnix
  71.     ARexxBox
  72.     make
  73.     flex
  74.     CatComp
  75.     ver        (included) utility for update the version string
  76.